swagger-java-client

Estuary API

• API version: 0.0.0
  • Build date: 2023-01-13T19:43:15.077Z[GMT]

This is the API for the Estuary application.

For more information, please visit https://docs.estuary.tech/feedback

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-java-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/swagger-java-client-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        try {
            ApiMinerResp result = apiInstance.adminMinersGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#adminMinersGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        List<String> body = Arrays.asList("body_example"); // List<String> | Peer ids
        try {
            String result = apiInstance.adminPeeringPeersDelete(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#adminPeeringPeersDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        try {
            String result = apiInstance.adminPeeringPeersGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#adminPeeringPeersGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        List<PeeringPeeringPeer> body = Arrays.asList(new PeeringPeeringPeer()); // List<PeeringPeeringPeer> | Peering Peer array
        try {
            String result = apiInstance.adminPeeringPeersPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#adminPeeringPeersPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        try {
            String result = apiInstance.adminPeeringStartPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#adminPeeringStartPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        try {
            String result = apiInstance.adminPeeringStatusGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#adminPeeringStatusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        try {
            String result = apiInstance.adminPeeringStopPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#adminPeeringStopPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        try {
            String result = apiInstance.adminSystemConfigGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#adminSystemConfigGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        try {
            String result = apiInstance.adminUsersGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#adminUsersGet");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to //api.estuary.tech/

Class	Method	HTTP request	Description
AdminApi	adminMinersGet	GET /admin/miners/	Get all miners
AdminApi	adminPeeringPeersDelete	DELETE /admin/peering/peers	Remove peers on Peering Service
AdminApi	adminPeeringPeersGet	GET /admin/peering/peers	List all Peering peers
AdminApi	adminPeeringPeersPost	POST /admin/peering/peers	Add peers on Peering Service
AdminApi	adminPeeringStartPost	POST /admin/peering/start	Start Peering
AdminApi	adminPeeringStatusGet	GET /admin/peering/status	Check Peering Status
AdminApi	adminPeeringStopPost	POST /admin/peering/stop	Stop Peering
AdminApi	adminSystemConfigGet	GET /admin/system/config	Get systems(estuary/shuttle) config
AdminApi	adminUsersGet	GET /admin/users	Get all users
AutoretrieveApi	adminAutoretrieveInitPost	POST /admin/autoretrieve/init	Register autoretrieve server
AutoretrieveApi	adminAutoretrieveListGet	GET /admin/autoretrieve/list	List autoretrieve servers
AutoretrieveApi	autoretrieveHeartbeatPost	POST /autoretrieve/heartbeat	Marks autoretrieve server as up
CollectionsApi	collectionsColuuidCommitPost	POST /collections/{coluuid}/commit	Produce a CID of the collection contents
CollectionsApi	collectionsColuuidContentsDelete	DELETE /collections/{coluuid}/contents	Deletes a content from a collection
CollectionsApi	collectionsColuuidDelete	DELETE /collections/{coluuid}	Deletes a collection
CollectionsApi	collectionsColuuidGet	GET /collections/{coluuid}	Get contents in a collection
CollectionsApi	collectionsColuuidPost	POST /collections/{coluuid}	Add contents to a collection
CollectionsApi	collectionsFsAddPost	POST /collections/fs/add	Add a file to a collection
CollectionsApi	collectionsGet	GET /collections/	List all collections
CollectionsApi	collectionsPost	POST /collections/	Create a new collection
ContentApi	adminInvitesCodePost	POST /admin/invites/{code}	Create an Estuary invite
ContentApi	adminInvitesGet	GET /admin/invites	Get Estuary invites
ContentApi	contentAddCarPost	POST /content/add-car	Add Car object
ContentApi	contentAddIpfsPost	POST /content/add-ipfs	Add IPFS object
ContentApi	contentAddPost	POST /content/add	Add new content
ContentApi	contentAggregatedContentGet	GET /content/aggregated/{content}	Get aggregated content stats
ContentApi	contentAllDealsGet	GET /content/all-deals	Get all deals for a user
ContentApi	contentBwUsageContentGet	GET /content/bw-usage/{content}	Get content bandwidth
ContentApi	contentContentsGet	GET /content/contents	Get user contents
ContentApi	contentCreatePost	POST /content/create	Add a new content
ContentApi	contentDealsGet	GET /content/deals	Content with deals
ContentApi	contentEnsureReplicationDatacidGet	GET /content/ensure-replication/{datacid}	Ensure Replication
ContentApi	contentFailuresContentGet	GET /content/failures/{content}	List all failures for a content
ContentApi	contentIdGet	GET /content/{id}	Content
ContentApi	contentListGet	GET /content/list	List all pinned content
ContentApi	contentStagingZonesGet	GET /content/staging-zones	Get staging zone for user, excluding its contents
ContentApi	contentStagingZonesStagingZoneContentsGet	GET /content/staging-zones/{staging_zone}/contents	Get contents for a staging zone
ContentApi	contentStagingZonesStagingZoneGet	GET /content/staging-zones/{staging_zone}	Get staging zone without its contents field populated
ContentApi	contentStatsGet	GET /content/stats	Get content statistics
ContentApi	contentStatusIdGet	GET /content/status/{id}	Content Status
DealsApi	dealEstimatePost	POST /deal/estimate	Estimate the cost of a deal
DealsApi	dealInfoDealidGet	GET /deal/info/{dealid}	Get Deal Info
DealsApi	dealProposalPropcidGet	GET /deal/proposal/{propcid}	Get Proposal
DealsApi	dealQueryMinerGet	GET /deal/query/{miner}	Query Ask
DealsApi	dealStatusByProposalPropcidGet	GET /deal/status-by-proposal/{propcid}	Get Deal Status by PropCid
DealsApi	dealStatusMinerPropcidGet	GET /deal/status/{miner}/{propcid}	Deal Status
DealsApi	dealTransferInProgressGet	GET /deal/transfer/in-progress	Transfer In Progress
DealsApi	dealTransferStatusPost	POST /deal/transfer/status	Transfer Status
DealsApi	dealsFailuresGet	GET /deals/failures	Get storage failures for user
DealsApi	dealsMakeMinerPost	POST /deals/make/{miner}	Make Deal
DealsApi	dealsStatusDealGet	GET /deals/status/{deal}	Get Deal Status
DealsApi	publicDealsFailuresGet	GET /public/deals/failures	Get storage failures
DealsApi	publicMinersStorageQueryMinerGet	GET /public/miners/storage/query/{miner}	Query Ask
DefaultApi	viewerGet	GET /viewer	Fetch viewer details
MetricsApi	publicMetricsDealsOnChainGet	GET /public/metrics/deals-on-chain	Get deal metrics
MinerApi	minerClaimMinerGet	GET /miner/claim/{miner}	Get Claim Miner Message
MinerApi	minerClaimPost	POST /miner/claim	Claim Miner
MinerApi	minerSetInfoMinerPut	PUT /miner/set-info/{miner}	Set Miner Info
MinerApi	minerSuspendMinerPost	POST /miner/suspend/{miner}	Suspend Miner
MinerApi	minerUnsuspendMinerPut	PUT /miner/unsuspend/{miner}	Unuspend Miner
MinerApi	publicMinersDealsMinerGet	GET /public/miners/deals/{miner}	Get all miners deals
MinerApi	publicMinersStatsMinerGet	GET /public/miners/stats/{miner}	Get miner stats
NetApi	adminMinersGet	GET /admin/miners/	Get all miners
NetApi	publicMinersFailuresMinerGet	GET /public/miners/failures/{miner}	Get all miners
NetApi	publicNetAddrsGet	GET /public/net/addrs	Net Addrs
NetApi	publicNetPeersGet	GET /public/net/peers	Net Peers
PinningApi	pinningPinsGet	GET /pinning/pins	List all pin status objects
PinningApi	pinningPinsPinidDelete	DELETE /pinning/pins/{pinid}	Delete a pinned object
PinningApi	pinningPinsPinidGet	GET /pinning/pins/{pinid}	Get a pin status object
PinningApi	pinningPinsPinidPost	POST /pinning/pins/{pinid}	Replace a pinned object
PinningApi	pinningPinsPost	POST /pinning/pins	Add and pin object
PublicApi	getCidGet	GET /get/{cid}	Get Full Content by Cid
PublicApi	publicByCidCidGet	GET /public/by-cid/{cid}	Get Content by Cid
PublicApi	publicInfoGet	GET /public/info	Get public node info
PublicApi	publicMetricsDealsOnChainGet	GET /public/metrics/deals-on-chain	Get deal metrics
PublicApi	publicMinersDealsMinerGet	GET /public/miners/deals/{miner}	Get all miners deals
PublicApi	publicMinersFailuresMinerGet	GET /public/miners/failures/{miner}	Get all miners
PublicApi	publicMinersStatsMinerGet	GET /public/miners/stats/{miner}	Get miner stats
PublicApi	publicNetAddrsGet	GET /public/net/addrs	Net Addrs
PublicApi	publicNetPeersGet	GET /public/net/peers	Net Peers
PublicApi	publicStatsGet	GET /public/stats	Public stats
UserApi	userApiKeysGet	GET /user/api-keys	Get API keys for a user
UserApi	userApiKeysKeyOrHashDelete	DELETE /user/api-keys/{key_or_hash}	Revoke a User API Key.
UserApi	userApiKeysPost	POST /user/api-keys	Create API keys for a user
UserApi	userExportGet	GET /user/export	Export user data
UserApi	userStatsGet	GET /user/stats	Get stats for the current user

Documentation for Models

• AddressAddress
• ApiChannelIDParam
• ApiClaimMsgResponse
• ApiClaimResponse
• ApiCreateCollectionBody
• ApiDeleteContentFromCollectionBody
• ApiEmptyResp
• ApiEstimateDealBody
• ApiGetApiKeysResp
• ApiMinerResp
• ApiPublicNodeInfo
• AutoretrieveInitBody
• CidCid
• CollectionsCidType
• CollectionsCollection
• CollectionsCollectionListResponse
• ContentAddBody
• MinerClaimMinerBody
• MinerMinerChainInfo
• MinerMinerSetInfoParams
• MinerSuspendMinerBody
• PeeringPeeringPeer
• TypesIpfsListPinStatusResponse
• TypesIpfsPin
• TypesIpfsPinStatusResponse
• TypesPinningStatus
• UtilContentAddResponse
• UtilContentCreateBody
• UtilContentType
• UtilDbCID
• UtilHttpError
• UtilUserSettings
• UtilViewerResponse

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author